.. _CSpell Class:

==========================
CSpell Class
==========================

.. toctree::
   :maxdepth: 1

* :ref:`Overview<CSpell_Overview>`
* :ref:`Quick Reference<CSpell_QuickRef>`
* :ref:`Constructors<CSpell_Constructors>`
* :ref:`Methods<CSpell_Methods>`

----

.. _CSpell_Overview:

Overview
---------------

.. note:: The **CSpell** class handles spells and spell information

The structure used for this class is :ref:`CSpell<CSpell>`

----

.. _CSpell_QuickRef:

Quick Reference
---------------

+-----------------------------------------------------------------------------------------------------------------------------------------------+
| **Quick Ref**                                                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| void **CCSpell\:\:~CSpell**\()                                                                                                                |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSpell\:\:Demand**\()                                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| Spell_ability_st\* **CSpell\:\:GetAbility**\(long abilityNum)                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSpell\:\:GetAbilityCount**\()                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CGameEffect<CGameEffect>`\* **CSpell\:\:GetAbilityEffect**\(long abilityNum, long effectNum, :ref:`CGameObject<CGameObject>`\* pObject) |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned short **CSpell\:\:GetAnimationType**\()                                                                                              |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| short **CSpell\:\:GetCasterType**\()                                                                                                          |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CGameEffect<CGameEffect>`\* **CSpell\:\:GetCastingEffect**\(long effectNum)                                                             |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| short **CSpell\:\:GetCastingEffectNo**\()                                                                                                     |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| :ref:`CResRef<CResRef>` **CSpell\:\:GetCastingSound**\()                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CSpell\:\:GetDescription**\()                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CSpell\:\:GetGenericName**\()                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| int **CSpell\:\:GetIcon**\(unsigned char\* resRef)                                                                                            |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CSpell\:\:GetItemFlags**\()                                                                                                   |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| short **CSpell\:\:GetLevel**\()                                                                                                               |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned long **CSpell\:\:GetNotUsableBy**\()                                                                                                 |
+-----------------------------------------------------------------------------------------------------------------------------------------------+
| unsigned char **CSpell\:\:GetSchool**\()                                                                                                      |
+-----------------------------------------------------------------------------------------------------------------------------------------------+


----

.. _CSpell_Constructors:

Constructors
---------------

+---------------------------------------------------------------+------------------------------------------------------+
| **Name**                                                      | **Description**                                      |
+---------------------------------------------------------------+------------------------------------------------------+
| :ref:`CSpell\:\:CSpell<CSpellCSpell>`                         | Constructs a ``CSpell`` object                       |
+---------------------------------------------------------------+------------------------------------------------------+

.. _CSpellCSpell:

CSpell\:\:CSpell
^^^^^^^^^^^^^^^^^^^^^^^^^

Constructs a ``CSpell`` object

::

   void CSpell::CSpell();

**Remarks**

Constructs a ``CSpell`` object


----

.. _CSpell_Methods:

Methods
---------------

+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| **Name**                                                      | **Description**                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:Demand<CSpellDemand>`                         |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetAbility<CSpellGetAbility>`                 |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetAbilityCount<CSpellGetAbilityCount>`       |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetAbilityEffect<CSpellGetAbilityEffect>`     |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetAnimationType<CSpellGetAnimationType>`     |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetCasterType<CSpellGetCasterType>`           |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetCastingEffect<CSpellGetCastingEffect>`     |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetCastingEffectNo<CSpellGetCastingEffectNo>` |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetCastingSound<CSpellGetCastingSound>`       |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetDescription<CSpellGetDescription>`         |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetGenericName<CSpellGetGenericName>`         |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetIcon<CSpellGetIcon>`                       |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetItemFlags<CSpellGetItemFlags>`             |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetLevel<CSpellGetLevel>`                     |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetNotUsableBy<CSpellGetNotUsableBy>`         |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+
| :ref:`CSpell\:\:GetSchool<CSpellGetSchool>`                   |                                                                                         |
+---------------------------------------------------------------+-----------------------------------------------------------------------------------------+


----

.. _CSpellDemand:

CSpell\:\:Demand
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetAbility:

CSpell\:\:GetAbility
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetAbilityCount:

CSpell\:\:GetAbilityCount
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetAbilityEffect:

CSpell\:\:GetAbilityEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetAnimationType:

CSpell\:\:GetAnimationType
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetCasterType:

CSpell\:\:GetCasterType
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetCastingEffect:

CSpell\:\:GetCastingEffect
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetCastingEffectNo:

CSpell\:\:GetCastingEffectNo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetCastingSound:

CSpell\:\:GetCastingSound
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetDescription:

CSpell\:\:GetDescription
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetGenericName:

CSpell\:\:GetGenericName
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetIcon:

CSpell\:\:GetIcon
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetItemFlags:

CSpell\:\:GetItemFlags
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetLevel:

CSpell\:\:GetLevel
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetNotUsableBy:

CSpell\:\:GetNotUsableBy
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**




----

.. _CSpellGetSchool:

CSpell\:\:GetSchool
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^



::

   x;

**Parameters**

*  * - 
*  * - 
*  * - 
*  * - 

**Return Value**

Returns 

**Remarks**